docs: add missing modules to sphinx documentation build#5017
Open
raajheshkannaa wants to merge 4 commits intoopen-telemetry:mainfrom
Open
docs: add missing modules to sphinx documentation build#5017raajheshkannaa wants to merge 4 commits intoopen-telemetry:mainfrom
raajheshkannaa wants to merge 4 commits intoopen-telemetry:mainfrom
Conversation
Contributor
|
Thanks @raajheshkannaa . Please could you sign the CLA as per contributing guidelines. |
raajheshkannaa
force-pushed
the
fix/sphinx-docs-build
branch
2 times, most recently
from
9ef33c3 to
20c26a9
Compare
Contributor
|
Thanks! Next please run
|
raajheshkannaa
force-pushed
the
fix/sphinx-docs-build
branch
2 times, most recently
from
4b5e95f to
67c8e08
Compare
Author
|
Rebased on main and ran |
raajheshkannaa
force-pushed
the
fix/sphinx-docs-build
branch
from
67c8e08 to
7e3617d
Compare
xrmx
moved this from Reviewed PRs that need fixes
to Easy to review / merge / close
in Python PR digest
raajheshkannaa
force-pushed
the
fix/sphinx-docs-build
branch
from
7e3617d to
8587cf4
Compare
Add RST files and toctree entries for modules that were not included in the sphinx doc build: API: - opentelemetry._events (Events API) - opentelemetry.attributes (Attributes utilities) - opentelemetry.trace.propagation (Trace context propagation) SDK: - opentelemetry.sdk._events (Events SDK implementation) - opentelemetry.sdk._logs.export (Log export processors and exporters) Closes open-telemetry#2573 Signed-off-by: Raajhesh Kannaa Chidambaram <495042+raajheshkannaa@users.noreply.github.com>
Signed-off-by: Raajhesh Kannaa Chidambaram <495042+raajheshkannaa@users.noreply.github.com>
Add CHANGELOG entry for the docs PR and suppress the Sphinx cross-reference warning for get_finished_logs (referenced as :func: in a docstring we did not modify).
raajheshkannaa
force-pushed
the
fix/sphinx-docs-build
branch
from
8587cf4 to
d93aa2b
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Closes #2573
Summary
Modules added
API:
opentelemetry._events- Events API (EventLogger, EventLoggerProvider)opentelemetry.attributes- Attribute validation and utility functionsopentelemetry.trace.propagation- Trace context propagation helpers (set/get span in context)SDK:
opentelemetry.sdk._events- Events SDK implementation (EventLogger, EventLoggerProvider)opentelemetry.sdk._logs.export- Log record export (BatchLogRecordProcessor, SimpleLogRecordProcessor, ConsoleLogExporter, InMemoryLogExporter)Notes
tox -e docsbuild has a pre-existing failure (Contextcross-reference ambiguity in_logs._internal.LogRecorddocstring) that is unrelated to this change and present onmaindocs/api/anddocs/sdk/Test plan
tox -e docslocally; all new modules are picked up by sphinx-build (visible in the "reading sources" and "highlighting module code" output)